WatchList Tool – Properties

The following table lists and describes properties of the WatchList Tool as they are exposed on the Property Sheet and/or in the tool's script editor. Many of these properties are also exposed on a tool's (OCXProperties) property sheets. A property's name sometimes varies depending on where it appears.

Note: If a property or method in the script editor has two forms with the same name, one form exists for legacy support and the other form is current. When possible, use the current form. To select the current form, append .X. to the name of the object to which the property or method applies, and then enter the property or method name. For instance, enter MyObject.X.MyProperty. If a property or method in the script editor has only one form, the X method might or might not apply. The column in the table below indicates whether or not a property or method is accessible using the X method.

Property Sheet	Script Editor		Description
AllowUnitsChange	AllowUnitsChange	Yes	Enables unit changes to be displayed in Run mode. Unit types affected are primary and alternate. Options are 0 - No and 1 - Yes. The default is 1 - Yes. If 0 - No is specified, the Use Alternate Units option is disabled in Run mode. Script subtype is Boolean.
AlternateUnits	AlternateUnits	Yes	Specifies that the object display values in alternate units instead of primary units. Alternate units must be defined in the point configuration record for the relevant point. Otherwise, alternate units cannot be displayed by the tool. Property sheet options are 0 - No and 1 - Yes. Default is 0 - No. Script subtype is Boolean.
Appearance	Appearance	Yes	Appearance specifies whether the object boundary (graph, cell in the grid, view, etc.) will have a 3D effect or a flat appearance. Options are 0 - Flat or 1 - 3D. Default is 0 - Flat.
N/A	BackColor	No	Selects a background color for the object or grid. Note that if an object’s [AlarmElement] property is set to Background Color and a primary point is assigned to the object, the background color will change in Run mode to reflect the point status. The default is Automatic, which is the background color of TheView for most objects. For the Group Grid Tool, BackColor specifies the background color for the object’s cell space. This does not affect the background color of the cells. To set the background color of the cells, enable UseCustomStateColors (Property Sheet, ActiveX page) and define the custom colors. For the CygNet GCM Nomination Grid, the default is white (RGB 255.255.255). For the SetPoint Button Tool, BackColor is a script property that specifies the background color of the value and the confirmation prompt dialog box for the SetPoint Button object. UsePrompt must be enabled for this setting to be recognized by the SetPoint Button object. Script subtype is long. For the Trend Tool, specifies the background color of a trend. Default is gray (RGB 240.240.240). Script subtype is long. Note: In script, you can set this and other color properties using the VBScript function 'control.somecolor = RGB (255,0,0).'
BlinkIntervalMS	BlinkIntervalMS	Yes	Specifies the time (in milliseconds) between blinks. Default is 500.
BorderStyle	BorderStyle	Yes	BorderStyle specifies the border style of the object boundary. Most tools use one of these sets of options: 0 - ibsNone, 1 - ibsRaised, or 2 - ibsLowered, and the default is 0 - ibsNone 0 - None or 1 - Fixed Single, and the default is 0 - None The Panel Switch Tool uses these options: 0 - ibsLine, 1 - ibsRaised, 2 - ibsLowered, 3 - ibsTop, and 4 - ibsNone, and the default is 0 - ibsLine. For the Box, Frame, and Text tools, the BorderStyle property specifies the style of the object’s foreground lines. The options are: 0 - Normal, 1 - 3D, 2 - Sunken, 3 - Raised, and 4 - None The default for the Box Tool is 0 - Normal. The default for the Frame Tool is 1 - 3D. The default for the Text Tool is 4 - None. If you use 2 - Sunken or 3 - Raised and the effect is not visible, change the object’s HiliteColor. If you use 0 - Normal, 2 - Sunken, or 3 - Raised, you can set the border width using the PenWidth property. For TheFrame/TheView, the BorderStyle property specifies both the style of the object's border and whether the object can be resized by the user in Run mode. The default is 0 - Thin, which means the border is thin and the size is static. The other possible option is 1 - Resizing, which means the border is thicker and can be resized. See also Appearance. Script subtype is integer.
Bottom	Bottom		Bottom specifies the distance in pixels from the top of the object to the bottom of the object. You can dynamically change this value in Edit mode if you use the mouse to enlarge or shrink the object.
ButtonLabel	ButtonLabel	Yes	Specifies the text for the Buttons column for a WatchList Tool.
Columns	Columns	Yes	Specifies the number of columns that are defined for the object or the XML that represents the list of displayed columns. Use the OCX Properties dialog box to select. For a WatchList Tool, Columns specifies the identifier of each column. Items are semicolon separated.
CursorPointer	CursorPointer	No	For TheView, CursorPointer selects the cursor icon that appears when you mouse over objects. For objects, CursorPointer selects the cursor icon for the instance of the object. The object’s cursor pointer takes precedence over TheView’s cursor pointer. The default is 0 - Default. For TheView, this is an arrow. For other objects, the icon configured for TheView is used. Other options are: 1 - Arrow 2 - IBeam 3 - Cross 4 - UpArrow 5 - NoDrop 6 - Help 99 - HotSpot 100 - Timer Script subtype is long.
N/A	DisplayFont	No
Enable	Enable	No	Enable specifies whether the user is able to interact with the object. Options are 0 - No and 1 - Yes. The default is 1 - Yes. If set to 0 - No, the object is still visible but its context menu is disabled. Other options: Completely hide the object in run mode using the Visible property. Display the object but hide its [DisplayItem] using the [DisplayElement] property.
FlexHorizontal	N/A	No	FlexHorizontal specifies whether the object moves or resizes horizontally or is unchanged when TheFrame is resized. Options are: 0 - None (no resizing occurs) 1 - Shift (the object is shifted) 2 - Expand (the object expands or shrinks the same number of pixels as TheFrame) 3 - Proportional (the object expands or shrinks proportionally to TheFrame) Default is 0 - None.
FlexVertical	N/A	No	FlexVertical specifies whether the object moves or resizes vertically when TheFrame is resized. Options are: 0 - None (no resizing occurs) 1 - Shift (the object is shifted) 2 - Expand (the object expands or shrinks the same number of pixels as TheFrame) 3 - Proportional (the object expands or shrinks proportionally to TheFrame) Default is 0 - None.
Font	Font	Yes	Font specifies the font for the object. For TheView, this property specifies the default font for text-based objects. For other objects, it specifies the font for the instance of the object. The object’s font takes precedence over the font set for TheView. Click … to view the Font dialog box, which you can use to configure the font. The default is MS Shell Dlg (MS Sans Serif, regular, 8 pt). Script subtype is string. Note: In script, you can set font properties using "-13, Arial" for example.
N/A	ForeColor	No	ForeColor specifies the foreground color for the object. The default is Automatic, which, for most objects is black. Note that if the object’s [AlarmElement] is set to Foreground Color and a primary point has been assigned to the object, the foreground color will change in Run mode to reflect the point status. Note: In script, you can set this and other color properties using the VBScript function 'control.somecolor = RGB (255,0,0).'
Group	Group	No	Group groups objects into a discrete sequence that can be navigated using the arrow keys. Options are 0 - No and 1 - Yes. The default is 0 - No. To use this property: 1. Add objects that use the Group property to a screen. 2. Position them as you like (typically in a spatial configuration that reflects the order in which they were added to the screen). 3. Decide where in the spatial configuration logical groups begin and end. 4. Mark the beginning of a group by setting the Group property to 1 - Yes for the first object in the group. 5. Set Group set to 0 - No for other objects in the group. The group is made up of all objects that 1) are added sequentially after an object with a Group property set to 1 - Yes and 2) that use a Group property set to 0 - No. A group's arrow navigation sequence reflects the order in which its objects were added to a screen. This property is not related to the Draw > Group option in the CygNet Studio menu bar. This property might not be suited for use with all tools that include the Group property. Script subtype is long. See also Tabstop.
N/A	GroupID	No	Specifies the GroupID of the object group.
N/A	HasValidTag	No	Returns a Boolean value to confirm that a CygNet-aware tool is associated with a valid CygNet tag. This property may not be suited for use with all tools that include the HasValidTag property. See also CygNet-Aware Tools. Script subtype is Boolean.
HelpContextID	HelpContextID	No	HelpContextID specifies the object’s help identifier for context-sensitive help. TheFrame’s WhatsThisHelp must be enabled. Script subtype is long.
N/A	IsCygNetAware	No	Returns a Boolean value that confirms that an object is a CygNet-aware tool. This property might not be suited for use with all tools that include the IsCygNetAware property. Script subtype is Boolean. See also CygNet-Aware Tools.
Layer	N/A	No	Layer identifies the layer on which the object resides. Script subtype is Boolean.
N/A	LayerID	No	LayerId is a script property that specifies the layer on which the object resides. Options vary depending on the names of existing layers. Default is Default.
Left	Left	No	Left specifies the distance (in pixels) from the left edge of TheView’s scroll region to the left edge of the object.
Notification	Notification	Yes	Specifies the pop-up box notification message for a WatchList Tool. Use the OCX Properties dialog box to define.
(ObjectCode)	Code	No	(ObjectCode) specifies a unique identifier of the object. You can enter up to 39 characters. Valid characters are A-Z, 0-9, and underscore (_). Spaces are not allowed. The default is the object name and the numeric instance. Script subtype is string.
(OCXProperties)	N/A	No	Displays the OCXProperty dialog box unique to the object.
Right	Right	No	Right specifies the distance (in pixels) from the left edge of TheView’s scroll region to the right edge of the object.
N/A	RotateAngle	No	Causes the object to rotate clockwise the specified number of degrees. You can rotate an object directly by using the Rotate option on the Draw menu. For details, see Rotating an Object.
Tabstop	TabStop	No	Tabstop specifies whether the focus stops on the object when you use the Tab key to navigate between objects (in other words, enables the object as a tab stop). Options are 0 - No and 1 - Yes. Default is 1 - Yes. Script subtype is long. See also Group and Tab Order. Note: To set the tab order, use the Objects option on the Layout menu.
Tag	Tag	No	Tag is an extra field for application-specific purposes. Does not specify a CygNet point. Default is blank. Script subtype is string.
N/A	ToolTipText	No	TooltipText identifies text that is displayed when the mouse hovers over the object in Run mode. For some objects, tooltip text can be dynamic, static, or a combination. You build dynamic text with tokens that can represent point configuration, facility, and CVS point record properties. You can also specify data formatting. Click … to view the Edit Tooltip Text dialog box you use to configure the text. For information about building dynamic text using tokens, see Using Text Tokens. Script subtype is string. Note: Although this property is listed on the Property Sheet and in the Script Editor for many tools, it is not supported by all. For example, the Facility Navigation Bar, the Group Grid, and the Group Navigation Bar do not support this property.
N/A	ToolType	No	Returns a CygNet-defined string value that describes the object type. This value appears in the Status Bar when you hover over a default control in its tool palette. You can also display the value using a script. This property is read only. See also Rule-Based Substitution. Script subtype is string.
Top	Top	No	Top specifies the distance (in pixels) from the top of TheView’s scroll region to the Top of the object.
UpdateIntervalSec	UpdateIntervalSec	Yes	Specifies the time (in milliseconds) the WatchList object requests data from the cache.
[UseViewUnits]	UseViewUnits	No	Enables the object to use the [Units] property of TheView or the parent view (for the Nested View Tool) rather than its own units. Default is 0 - No.
Visible	Visible	No	Visible secifies whether the object is visible in Run mode. Options are 0 - No or 1 - Yes. Default is 1 - Yes. Note: Objects are always visible in Edit mode, regardless of how this property value is set. You can also: Display the object but hide its [DisplayItem] using the [DisplayElement] property. Show both the object and its [DisplayItem] but disable user interaction using the Enable property. Hide the object if the point does not exist using the [UnknownTag].

Property Sheet

Script Editor

Description

AllowUnitsChange

Yes

Enables unit changes to be displayed in Run mode. Unit types affected are primary and alternate. Options are 0 - No and 1 - Yes. The default is 1 - Yes. If 0 - No is specified, the Use Alternate Units option is disabled in Run mode. Script subtype is Boolean.

AlternateUnits

Yes

Specifies that the object display values in alternate units instead of primary units. Alternate units must be defined in the point configuration record for the relevant point. Otherwise, alternate units cannot be displayed by the tool. Property sheet options are 0 - No and 1 - Yes. Default is 0 - No. Script subtype is Boolean.

Appearance

Yes

Appearance specifies whether the object boundary (graph, cell in the grid, view, etc.) will have a 3D effect or a flat appearance. Options are 0 - Flat or 1 - 3D. Default is 0 - Flat.

N/A

BackColor

Selects a background color for the object or grid. Note that if an object’s [AlarmElement] property is set to Background Color and a primary point is assigned to the object, the background color will change in Run mode to reflect the point status.

The default is Automatic, which is the background color of TheView for most objects.

For the Group Grid Tool, BackColor specifies the background color for the object’s cell space. This does not affect the background color of the cells. To set the background color of the cells, enable UseCustomStateColors (Property Sheet, ActiveX page) and define the custom colors.
For the CygNet GCM Nomination Grid, the default is white (RGB 255.255.255).
For the SetPoint Button Tool, BackColor is a script property that specifies the background color of the value and the confirmation prompt dialog box for the SetPoint Button object. UsePrompt must be enabled for this setting to be recognized by the SetPoint Button object. Script subtype is long.
For the Trend Tool, specifies the background color of a trend. Default is gray (RGB 240.240.240). Script subtype is long.

Note: In script, you can set this and other color properties using the VBScript function 'control.somecolor = RGB (255,0,0).'

BlinkIntervalMS

Yes

Specifies the time (in milliseconds) between blinks. Default is 500.

BorderStyle

Yes

BorderStyle specifies the border style of the object boundary.

Most tools use one of these sets of options:

0 - ibsNone, 1 - ibsRaised, or 2 - ibsLowered, and the default is 0 - ibsNone

0 - None or 1 - Fixed Single, and the default is 0 - None

The Panel Switch Tool uses these options:

0 - ibsLine, 1 - ibsRaised, 2 - ibsLowered, 3 - ibsTop, and 4 - ibsNone, and the default is 0 - ibsLine.

For the Box, Frame, and Text tools, the BorderStyle property specifies the style of the object’s foreground lines. The options are:

0 - Normal, 1 - 3D, 2 - Sunken, 3 - Raised, and 4 - None

The default for the Box Tool is 0 - Normal. The default for the Frame Tool is 1 - 3D. The default for the Text Tool is 4 - None.

If you use 2 - Sunken or 3 - Raised and the effect is not visible, change the object’s HiliteColor.

If you use 0 - Normal, 2 - Sunken, or 3 - Raised, you can set the border width using the PenWidth property.

For TheFrame/TheView, the BorderStyle property specifies both the style of the object's border and whether the object can be resized by the user in Run mode. The default is 0 - Thin, which means the border is thin and the size is static. The other possible option is 1 - Resizing, which means the border is thicker and can be resized.